MapLibre Native for Android/com.mapbox.mapboxsdk.offline/OfflineTilePyramidRegionDefinition

OfflineTilePyramidRegionDefinition

class OfflineTilePyramidRegionDefinition : OfflineRegionDefinition

An offline region defined by a style URL, geographic bounding box, zoom range, and device pixel ratio.

Both minZoom and maxZoom must be ≥ 0, and maxZoom must be ≥ minZoom.

maxZoom may be ∞, in which case for each tile source, the region will include tiles from minZoom up to the maximum zoom level provided by that source.

pixelRatio must be ≥ 0 and should typically be 1.0 or 2.0.

if includeIdeographs is false, offline region will not include CJK glyphs

Constructors

Link copied to clipboard
fun OfflineTilePyramidRegionDefinition(styleURL: String?, bounds: LatLngBounds, minZoom: Double, maxZoom: Double, pixelRatio: Float)

Constructor to create an OfflineTilePyramidDefinition from parameters.

Link copied to clipboard
fun OfflineTilePyramidRegionDefinition(styleURL: String?, bounds: LatLngBounds, minZoom: Double, maxZoom: Double, pixelRatio: Float, includeIdeographs: Boolean)

Constructor to create an OfflineTilePyramidDefinition from parameters.

Link copied to clipboard
fun OfflineTilePyramidRegionDefinition(parcel: Parcel)

Constructor to create an OfflineTilePyramidDefinition from a Parcel.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun describeContents(): Int
Link copied to clipboard
open override fun writeToParcel(dest: Parcel, flags: Int)

Properties

Link copied to clipboard
open override val bounds: LatLngBounds?

Gets the bounds of the OfflineRegion.

Link copied to clipboard
open override var includeIdeographs: Boolean

Specifies whether to include ideographic glyphs in downloaded font data. Ideographic glyphs make up the majority of downloaded font data, but it is possible to configure the renderer to use locally installed fonts instead of relying on fonts downloaded as part of the offline pack.

Link copied to clipboard
open override var maxZoom: Double

Gets the maximum zoom level the OfflineRegion map can be displayed at.

Link copied to clipboard
open override var minZoom: Double

Gets the minimum zoom level the OfflineRegion map can be displayed at.

Link copied to clipboard
open override var pixelRatio: Float

Gets the pixel ratio of the OfflineRegion map.

Link copied to clipboard
open override var styleURL: String?

Returns the map style url of the OfflineRegion.

Link copied to clipboard
open override val type: String

Gets the type of the OfflineRegionDefinition ("tileregion", "shaperegion").